home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / schat205.zip / SCHAT!.DOC < prev    next >
Text File  |  1990-11-13  |  21KB  |  547 lines
  1.  
  2.  
  3.  ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐  ┌─────┐ ┌──┬──┐ ┌─────┐ ┌─────┐  ┌─┐
  4. ░│  ───┤░│  │  │░│  ── │░│  ── │░│  ───┤░░│     │░│  │  │░│  │  │░└─┐ ┌─┘░░│ │░
  5. ░│     │░│     │░│  ── │░│    ─┤░│  ───┤░░│  ───┤░│     │░│     │░░░│ │░░░░│ │░
  6. ░├───  │░│  │  │░│     │░│     │░│     │░░│     │░│     │░│  │  │░░░│ │░░░░└─┘░
  7. ░│     │░│  │  │░│     │░│   │ │░│     │░░│     │░│  │  │░│  │  │░░░│ │░░░░┌─┐░
  8.  └─────┘ └──┴──┘ └─────┘ └───┴─┘ └─────┘  └─────┘ └──┴──┘ └──┴──┘   └─┘    └─┘
  9.                             V e r s i o n   2 . 0 5
  10.         C o p y r i g h t   ( C )   1 9 9 0   S h a w n   G r e s h a m
  11.  
  12.                             Home Base at Joel Karr's
  13.                  Electrodes BBS (214) 868-2794 FIDOnet 1/19:55
  14.  
  15.  
  16. C r e d i t s
  17. ─────────────
  18.  
  19.         The following products are copyrighted material and/or
  20.         trademarks of their copyright and/or trademark holders
  21.         respectively:
  22.  
  23.         DESQview                Quarterdeck Systems
  24.         Remote Access, RABBS    Continental Software
  25.         MASM                    Microsoft Corporation
  26.  
  27.  
  28. W h a t   i s   S a b r e   C h a t !
  29. ─────────────────────────────────────
  30.  
  31.         Sabre Chat! is a cross-node/cross-environment chat
  32.         utility for Remote Access Bulletin Boards Systems
  33.         providing a means for users on different nodes to conduct
  34.         'real-time' communication.
  35.  
  36.         Sabre Chat! provides the following options:
  37.  
  38.         ■ Character-by-character communications instead of
  39.           the confusing, jerky line-by-line method.
  40.  
  41.         ■ Runs on nodes separated by DESQview, NetBios, or a
  42.           RS232 cable.
  43.  
  44.         ■ Supports ANSI on/off (hi/lo intensity) and 40/80 column
  45.           displays.
  46.  
  47.         ■ Supports up to 8 nodes under DESQview and 99 nodes
  48.           under NetBios.
  49.  
  50.         ■ Allows paging to a user on another RA node.
  51.  
  52.         ■ Optional name-prompting to reduce confusion in
  53.           conversations of 3 or more users.
  54.  
  55.         ■ Can be used to create Conference menus for more than
  56.           one concurrent chat session.
  57.  
  58.         Sabre Chat! is written in 8088 assembly language and
  59.         assembled with Microsoft's Macro Assembler Version 5.10
  60.         for smaller EXE size and faster execution.  For those who
  61.         are curious, the source is 70k long, but not included. :)
  62.  
  63.  
  64. R e g i s t r a t i o n
  65. ───────────────────────
  66.  
  67.         Sabre Chat! has evolved to be a fantastic utility for a
  68.         multi-node bbs. Shawn has worked many many hard hours on
  69.         making it THE chat door for the users. And that is the name
  70.         of the game! For if not for the users then all of us SysOps
  71.         would be lookin at a dead screen. I (Joel) feel that Shawn,
  72.         which is working his way thru college, is due alittle
  73.         recognition for his hard work. I ask for you to find it in
  74.         yourself to help support programmers like Shawn that are
  75.         dedicated to making it a better tele-comm world for all of
  76.         us. SChat! is in no way crippled nor will you gain anything
  77.         from registering it other than the good feeling inside!
  78.         We ask that you send $15.00 USA to help contribute to the
  79.         funds of keeping Shawn developing new utilities for us.
  80.         If the money is a problem, then at least drop Shawn a netmail
  81.         message letting him know that you support him.
  82.  
  83.         Send registration to:
  84.  
  85.                 Shawn Gresham
  86.                 Rt 1 Box 544
  87.                 Gordonville, TX
  88.                           76245
  89.  
  90.  
  91. S C h a t !   F i l e s
  92. ───────────────────────
  93.  
  94.         The following files are included in the Sabre Chat! zip
  95.         file.
  96.  
  97.         SCHAT!.EXE      The main executing file.
  98.  
  99.         SCHAT!.DOC      This Manual.
  100.  
  101.         WIPE!.EXE       Helpful for creating a correct size
  102.                         USERON.BBS.
  103.  
  104.         MIXER!.COM      Creates a memory buffer for Sabre Chat!
  105.                         when being used under DESQview.  Supports
  106.                         up to 8 nodes at once.
  107.  
  108.         DUET!.COM       Creates a memory buffer like MIXER! but
  109.                         only supports 2 nodes at once.
  110.  
  111.  
  112. I n s t a l l i n g   S a b r e   C h a t !
  113. ───────────────────────────────────────────
  114.  
  115.         To install Sabre Chat!, you will need to create a environment
  116.         variable called SCHAT! and point it toward the main directory
  117.         of your bulletin board system.  For Remote Access systems
  118.         SCHAT! will be set to the same directory as your RA variable
  119.         is set. Also do NOT add a trailing '\' to the path name.
  120.  
  121.         For example: SET SCHAT!=C:\RA
  122.  
  123.         I would suggest that you throughly read this document for the
  124.         information that you need for you system.
  125.  
  126.  
  127. C o m m a n d   L i n e   O p t i o n s
  128. ───────────────────────────────────────
  129.  
  130.         Below is a listing of all the command line parameters needed to
  131.         execute Sabre Chat!.  I have included a full length description
  132.         of each and usage examples to help prevent confusion.
  133.  
  134.   A     Ansi Usage.
  135.  
  136.             This flag determines whether Ansi commands are sent to
  137.             an online user.  Ansi is always sent to the local system.
  138.  
  139.             A<0 or 1> where 1 = ON and 0 = OFF.
  140.  
  141.             Default: A0                 - Ansi Off
  142.  
  143.             Example: SCHAT! A1          - Ansi On
  144.                      SCHAT! A0          - Ansi Off
  145.  
  146.   C     Select Talk Port.
  147.  
  148.             Selects communications port to be used for cross-node
  149.             communications.  Not to be confused with P (Call Com
  150.             Port) that determines the communication port for the
  151.             caller.  Only use this command if you wish to use a
  152.             communications port for cross-node chatting otherwise
  153.             do not include it on the command line.
  154.  
  155.             C<port> where port is 1-8 or whatever your driver
  156.                           supports.
  157.  
  158.             Default: None
  159.  
  160.             Example: SCHAT! C1          - Use COM1
  161.  
  162.   F     Define Message Filename.
  163.  
  164.             RA versions 0.03 and above use NODE??.RA to send
  165.             messages to other nodes. Earlier versions of RA
  166.             use TMP??.TMP.  The F command allows the sysop
  167.             to specify the filename if he does not wish to
  168.             use NODE??.RA.
  169.  
  170.             F<filename> where filename is a legal filename
  171.                               with ?? in place of the node
  172.                               number.
  173.  
  174.             Default: FNODE??.RA
  175.  
  176.             Example: SCHAT! FTMP??.TMP  -RA 0.02 compatible
  177.  
  178.    L    Use NetBios and Specify LANA Card Number.
  179.  
  180.             Allows Sabre Chat! to run on systems running
  181.             NetBios without having to use an RS232 cable.
  182.             Do not include if you wish to use the C <talk
  183.             port> or V<Memory Buffers> options.
  184.  
  185.             L<LANA Card> where LANA Card is 0 or greater.
  186.  
  187.             Default: None
  188.  
  189.             Example: SCHAT! L0  - activates netbios with LANA 1
  190.  
  191.    M    Activate Name Prompting.
  192.  
  193.             Precedes each users text with his name to reduce
  194.             confusion in a chat session with 3 or more people.
  195.  
  196.             Default: Disabled
  197.  
  198.             Example: SCHAT! M           - Name prompting enabled
  199.  
  200.    N    Assign Node.
  201.  
  202.             Selects node to use when reading USERON.BBS for
  203.             the user information.
  204.  
  205.             N<node> where node is a valid RA node 1-99.
  206.  
  207.             Default: N1         - Node 1
  208.  
  209.             Example: SCHAT! N3  - Node 3
  210.  
  211.    O    Select Conference Name.
  212.  
  213.             Used with the L <NetBios> option to allow a
  214.             multi-conference system.  Allows SysOp to
  215.             specify the name used by NetBios for communi-
  216.             cation.  The name must be valid to netbios (no *
  217.             or bizarre characters).  More Information on
  218.             conferencing is included later in the 'Using
  219.             Netbios' chapter in this manual.
  220.  
  221.             O<conference name> where conference name is a
  222.                                      valid netbios name.
  223.  
  224.             Default: OSCHAT!
  225.  
  226.             Example: SCHAT! L0 OGIRLS   - use netbios with the
  227.                                           name GIRLS.
  228.  
  229.    P    Select Caller Communications Port.
  230.  
  231.             Specifies the com port to be used for the online
  232.             caller.  Be careful not to confuse this command
  233.             with the C <talk port> option. This option is
  234.             ignored if the caller is local (i.e. baudrate 0).
  235.             Should be the same port as being used by the
  236.             bulletin board.
  237.  
  238.             P<port> where port is a valid communications port 1-8.
  239.  
  240.             Default: None
  241.  
  242.             Example: SCHAT! P1       - Use COM1
  243.  
  244.    T    Set Minutes Remaining.
  245.  
  246.             Sets the maximum amount of time allowed in chat in
  247.             minutes before Sabre Chat! will return the user to
  248.             the BBS.
  249.  
  250.             T<minutes> where minutes is 0-255.
  251.  
  252.             Default: T20        - 20 minutes
  253.  
  254.             Example: T90        - 1 Hr 30 Minutes
  255.  
  256.   U     Allow User-Defined Conference Names.
  257.  
  258.             Allows callers to create their own conference names
  259.             so that two callers may have a 'private' chat.  The
  260.             callers is prompted for a eight character name and
  261.             enters that SChat! Conference Area. This requires
  262.             that both callers know the name they wish to
  263.             communicate with.  Please see the 'Using NetBios'
  264.             chapter in this manual for menu examples. This option
  265.             requires the L <netbios> and NetBios to operate.
  266.  
  267.             Default: None
  268.  
  269.             Example: SCHAT! L0 U  - use NetBios with User-
  270.                                     Defined Conference Names.
  271.  
  272.   V     Use Memory Buffers.
  273.  
  274.             Allows Sabre Chat! to communicate across windows on a
  275.             DESQview system. This option requires that MIXER!.COM
  276.             was executed before entering DESQview.  Be careful using
  277.             this option with the C <talk port> and L <netbios>
  278.             options.  Please read the 'Mixing Inputs' chapter later
  279.             in this manual.
  280.  
  281.             Default: None
  282.  
  283.             Example: SCHAT! V   - allows operation cross-DESQview windows
  284.  
  285.  
  286. U s i n g   S a b r e   C h a t !   W i t h   R A B B S
  287. ───────────────────────────────────────────────────────
  288.  
  289.         Sabre Chat! has been designed on, around, and for Remote
  290.         Access Bulletin Boards.  All of the command line
  291.         parameters have a RABBS counterpart to allow easy setup.
  292.         A full listing of these options are on page 32 and 33 of
  293.         the RA.DOC file.  The most used options are included
  294.         below.
  295.  
  296.         *G      Ansi Graphics 0=off / 1=On
  297.                 used with SChat!'s A option as A*G
  298.  
  299.         *N      Current Node
  300.                 used with SChat!'s N option as N*N
  301.  
  302.         *P      Communications Port
  303.                 used with SChat!'s P option as P*P
  304.  
  305.         *T      Time remaining in minutes
  306.                 used with SChat!'s T option as T*T
  307.  
  308.         These commands are the exact counterpart to Sabre Chat!'s
  309.         command line options.  Sabre Chat! can be executed by
  310.         RA's Type 7 menu.  Example as follows:
  311.  
  312.         USER TEXT  : (S)abre Chat!
  313.         MENU TYPE  : 7
  314.         OTHER TEXT : SCHAT!.EXE N*N P*P T*T A*G
  315.         HOT KEY    : 'S'
  316.  
  317.         Currently, LANA settings for the net option will have to
  318.         be 'hard-set' at the command line because RA does not
  319.         have a counterpart.
  320.  
  321.         OTHER TEXT : SCHAT!.EXE N*N P*P T*T A*G L0
  322.  
  323.  
  324. U s i n g   D E S Q v i e w
  325. ───────────────────────────
  326.  
  327.         Sabre Chat! operates under DESQview using the V <memory
  328.         buffers> option .  To use SChat! under DESQview with the
  329.         V option, you must first execute MIXER!.COM or DUET!.COM
  330.         before entering DESQview.  These two programs create the
  331.         TSR's and buffers that Sabre Chat! will use later to
  332.         communicate inbetween windows.  MIXER!.COM allocates a 1K
  333.         buffer for support up to 8 nodes active in SChat! at once.
  334.         DUET!.COM only opens a 256 byte buffer and supports only two
  335.         nodes at once but is slightly faster and ideal for a two-line
  336.         system.
  337.  
  338.         Example of a DESQview call would be as follows:
  339.  
  340.         SCHAT!.EXE N*N P*P A*G V
  341.  
  342.  
  343. U s i n g   N e t B i o s
  344. ─────────────────────────
  345.  
  346.         Sabre Chat! Version 2.05 is the first of the SCHAT! series to
  347.         allow communication via NetBios.  Data transfer is processed
  348.         using the datagram commands included in NetBios for those that
  349.         are curious as to how I am achieving this.  A Group Name is
  350.         created by each node when Sabre Chat! is executed and text is
  351.         sent to and from that name.  I have included a means by which
  352.         the SysOp can specify that name to allow several independent
  353.         chat sessions at once and a means for the users to create
  354.         their own conference names (if selected on the command line).
  355.         User-created names are actually eight-character names used in
  356.         creating a group name like 'SCHAT!xxxxxxxx' where 'xxxxxxxx'
  357.         is the name the user entered.
  358.  
  359.         I have include a standard RA menu example to show what I mean.
  360.  
  361.         SCHAT.ASC example
  362.  
  363.                          Welcome To The Conference Area
  364.  
  365.                              Conferences Availiable
  366.                              ──────────────────────
  367.                                  (F)ree For All
  368.                                (L)ove Connection
  369.                                  (P)rivate Talk
  370.                                  (S)ysOp's Only
  371.                                  (Q)uit to Main
  372.  
  373.                               Select F,L,P,S or Q:
  374.  
  375.         SCHAT.MNU examples
  376.  
  377.         'F' - Type 7 : SCHAT!.EXE N*N P*P A*G L0
  378.         'L' - Type 7 : SCHAT!.EXE N*N P*P A*G L0 OLOVETALK
  379.         'P' - Type 7 : SCHAT!.EXE N*N P*P A*G L0 U
  380.         'S' - Type 7 : SCHAT!.EXE N*N P*P A*G L0 OSYSOPTLK
  381.         'Q' - typical goto or return to menu depending on how
  382.               you have it setup.
  383.  
  384.         The previous example is a simplified RA menu that shows
  385.         all the various options availiable for net systems. The
  386.         'F' menu option is just a standard SChat! setup with the
  387.         default group name 'SCHAT!' being used.  Option 'L' is an
  388.         example of the sysop-defined group name using 'LOVETALK'
  389.         as the tag to communicate across the net.  The 'P' option
  390.         allows two users to use a previously decided number to
  391.         conduct a private SChat! session using the U
  392.         <user-defined group name> option.  And finally the 'S'
  393.         menu option shows that mixed with RA's restricted
  394.         security access you could open restricted access SChat!
  395.         session with, in this case, 'SYSOPTLK' as the group name.
  396.  
  397.  
  398. U s i n g   R S 2 3 2
  399. ─────────────────────
  400.  
  401.         Sabre Chat! allows communication between two computers
  402.         connected with a Null-Modem RS232 cable (diagram for a
  403.         null-modem cable is supplied later in this document
  404.         courtesy of Joel Karr) for slightly faster flow on a
  405.         two-line system that does not have NetBios.  For
  406.         instance, if you had two computers each with two
  407.         communication ports, you could connect the computers
  408.         together by COM2 and allow users to call in to RA on COM1
  409.         on each computer.  SChat! could be setup to accept the
  410.         user on COM1 and send data to the other user by COM2. The
  411.         command line for this setup would be as follows
  412.         (simplified).
  413.  
  414.         SCHAT!.EXE P1 C2
  415.         or
  416.         SCHAT!.EXE N*N P*P C2
  417.  
  418.         This RS232 support option has probably been made obsolete
  419.         by the new NetBios support, but I've left it in incase.
  420.  
  421.  
  422. M i x i n g   I n p u t s
  423. ─────────────────────────
  424.  
  425.         Technically, it is possible to use the C <talk port>, L
  426.         <netbios>, and V <memory buffers> in combination to allow
  427.         cross-node/cross-environment communication.  An example
  428.         would be trying to setup SCHAT! on a system in which you
  429.         have 2 computers connected by a net, each running a node
  430.         of RA with one LANA card, while one of these computers is
  431.         also running DESQview and supporting a 3rd node.  For
  432.         this example, node 1 is on the computer with no DESQview,
  433.         and nodes 2 and 3 are supported by DESQview.  To allow
  434.         SChat! to run without a 'double-echo', node 1 would be
  435.         setup normally with the L0 option. The problem develops
  436.         with node 2 and 3 because there is only one LANA card.
  437.         A correct system could be arrange by setting node 2 with
  438.         both L0 and the V <memory buffers> options and node 3
  439.         with just V option where node 2 would act as a link
  440.         between node 1 and node 3.
  441.  
  442.         Due to the many different possiblities in system
  443.         configuration, the best possible setup may be determined
  444.         by trial and error on these multi-environment systems.
  445.         If you encounter difficulty in setting Sabre Chat! up on
  446.         one of these systems please drop us some netmail to the
  447.         address at the end of this manual.  Likewise, if you find
  448.         a clever way of operating SChat! on one of these systems
  449.         please drop us a note and we'll include it in the next
  450.         documentation update with credits.  We appreciate
  451.         feedback.
  452.  
  453.  
  454. T e c h n i c a l i t i e s
  455. ───────────────────────────
  456.  
  457.         For the sake of debugging, I have included a list of
  458.         system specific items that might cause conflict with
  459.         other software.
  460.  
  461.         ■ SChat! calls MIXER! and DUET!.COM via interrupt 66h.
  462.         ■ SChat! calls the fossil driver via interrupt 14h.
  463.         ■ SChat! calls NetBios via interrupt 5ch.
  464.         ■ SChat! sends RA one-line messages by first creating
  465.           a temporary called NODE??.TMP.
  466.         ■ SChat! gets it's user information from USERON.BBS.
  467.         ■ SChat! gets it's keyboard input from the fossil and
  468.           likewise uses it's screen output routines.
  469.  
  470.  
  471. H e l p   o r   C o m m e n t s
  472. ───────────────────────────────
  473.  
  474.         If you have any difficulties or comments, we would
  475.         appreciate any feedback (is there anybody out there?!?).
  476.         Please call Electrodes BBS (214) 868-2794 or NetMail at
  477.         1/19:55 to Shawn Gresham or Joel Karr.  We are also
  478.         available on the RA_SUPPORT and RA_UTIL echos.
  479.  
  480.  
  481. T h a n k s
  482. ───────────
  483.  
  484.         I'd like to thank the following people for all the various
  485.         things they did in the development of Sabre Chat!.
  486.  
  487.         Joel Karr, my number one BETA tester, for submitting his
  488.          delicate BBS for testing (still got your finger over that
  489.          reset key???) and for the invaluable programming help and
  490.          insight!
  491.  
  492.         Les Harding, for all the hours of testing the "other side"
  493.          and the technical help that made programming easier.
  494.  
  495.         Debbie Karr, for the moral support and soft drinks!!
  496.  
  497.         And to all the users of Electrodes BBS who had to deal with
  498.         Sabre Chat!'s moody tendencies...thanks guys and gals!!!
  499.  
  500.  
  501.  
  502. B e t a  T e a m
  503. ────────────────
  504.  
  505.         A special thanks goes out to our fantastic Beta Team.
  506.         Let's all take our hats off for these few brave souls.
  507.         Keep up the good work gang.
  508.  
  509.         Fred Horner                Rod Hancock
  510.         The Private EaR            Motor City Software
  511.         Waco, Tx                   Oshawa ON
  512.         1:388/10                   1:229/418
  513.         (817) 776-9877             (416) 579-6818
  514.  
  515.         Josh Zerlan                Steve Gabrilowitz
  516.         The Temporal Allance       NCC-1701
  517.         Ft. Collins CO             Orlando FL
  518.         1:306/23                   1:363/1701
  519.         (303) 484-6483             (407) 380-6446
  520.  
  521.         Gary Day
  522.         After Hours
  523.         Sherman TX
  524.         (n/a)
  525.         (903) 893-9110
  526.  
  527.  
  528. ───────────────────────────────────────────────────────
  529.         Wiring diagram for (NULL MODEM) cable for
  530.         inter-connection for use with SChat!.
  531. ───────────────────────────────────────────────────────
  532.  
  533.  computer 1                   computer 2
  534.  
  535.   pin 2 ─────────────────────── pin 3
  536.   pin 3 ─────────────────────── pin 2
  537.  
  538.   pin 5 ──┐
  539.   pin 6 ──┴──────────────────── pin 20
  540.  
  541.   pin 7 ─────────────────────── pin 7
  542.  
  543.                             ┌── pin 5
  544.   pin 20 ───────────────────┴── pin 6
  545.  
  546.  
  547.